Node / meshtastic / Meshtastic-Android / files / README.md

Displaying Rendered • View raw • Download

<p align="center">

<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="200"/>

</p>

<h1 align="center">Meshtastic-Android</h1>

!GitHub all releases







This is a tool for using Android (and Compose Desktop) with open-source mesh radios. For more information see our webpage: meshtastic.org. If you are looking for the device side code, see here.

This project is currently beta testing across various providers. If you have questions or feedback please Join our discussion forum or the Discord Group . We would love to hear from you!

The easiest, and fastest way to get the latest beta releases is to use our github releases. It is recommend to use these with Obtainium to get the latest updates.

Alternatively, these other providers are also available, but may be slower to update.

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"

alt="Get it on F-Droid"

width="24%">](https://f-droid.org/packages/com.geeksville.mesh/)

[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"

alt="Get it on IzzyOnDroid"

width="24%">](https://apt.izzysoft.de/fdroid/index/apk/com.geeksville.mesh)

[<img src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"

alt="Get it on GitHub"

width="24%">](https://github.com/meshtastic/Meshtastic-Android/releases)

[<img src="https://play.google.com/intl/enus/badges/static/images/badges/enbadgewebgeneric.png"

alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh]"

width="24%">](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-android-readme)

The play store is the last to update of these options, but if you want to join the Play Store testing program go to this URL and opt-in to become a tester.

If you encounter any problems or have questions, ask us on the discord, create an issue, or post in the forum and we'll help as we can.

The project's documentation is generated with Dokka and hosted on GitHub Pages. It is automatically updated on every push to the T383838main branch.

You can generate the documentation locally to preview your changes.

1. Run the Dokka task:

T282828

2. View the output:

The generated HTML files will be located in the T383838build/dokka/html directory. You can open the T383838index.html file in your browser to view the documentation.

The app follows modern Android development practices, built on top of a shared Kotlin Multiplatform (KMP) Core:

• KMP Modules: Business logic (T383838core:domain), data sources (T383838core:data, T383838core:database, T383838core:datastore), and communications (T383838core:network, T383838core:ble) are entirely platform-agnostic, targeting Android and Compose Desktop.

• UI: JetBrains Compose Multiplatform (Material 3) using Compose Multiplatform resources.

• State Management: Unidirectional Data Flow (UDF) with ViewModels, Coroutines, and Flow.

• Dependency Injection: Koin with Koin Annotations (K2 Compiler Plugin).

• Navigation: JetBrains Navigation 3 (Multiplatform routing with RESTful deep linking).

• Data Layer: Repository pattern with Room KMP (local DB), DataStore (prefs), and Protobuf (device comms).

The BLE stack uses a multiplatform interface-driven architecture. Platform-agnostic interfaces live in T383838commonMain, utilizing the Kable multiplatform BLE library to handle device communication across all supported targets (Android, Desktop). This provides a robust, Coroutine-based architecture for reliable device communication while remaining fully KMP compatible. See core/ble/README.md for details.

You can help translate the app into your native language using Crowdin.

Developers can integrate with the Meshtastic Android app using our published API library via JitPack. This allows third-party applications (like the ATAK plugin) to communicate with the mesh service via AIDL.

For detailed integration instructions, see core/api/README.md.

Additionally, the app includes a built-in Local TAK Server feature that can be enabled in settings. This runs a local TCP server on port 8089 to allow ATAK clients to connect directly and route their traffic over the mesh.

│ [!WARNING] Debug and release builds can be installed concurrently. This is solely to enable

│ smoother development, and you should avoid running both apps simultaneously. To ensure proper

│ function, force quit the app not in use.

https://meshtastic.org/docs/development/android/

Note: when building the T383838google flavor locally you will need to supply your own Google Maps Android SDK api key T383838MAPS_API_KEY in T383838local.properties in order to use Google Maps.

e.g.

T282828

Te6edf3MAPS_API_KEYTff7b72=Ta5d6ffyour_google_maps_api_key_here

For detailed instructions on how to contribute, please see our CONTRIBUTING.md file.

For details on our release process, see the RELEASE_PROCESS.md file.

!Alt

Copyright 2025, Meshtastic LLC. GPL-3.0 license